Skip to content

ci: Check that SECURITY.md covers the releases - #454

Merged
ferenc-csaky merged 1 commit into
mainfrom
ci/release-docs-check
Nov 17, 2026
Merged

ferenc-csaky merged 1 commit into
mainfrom
ci/release-docs-check

Conversation

@ferenc-csaky

Copy link
Copy Markdown
Collaborator

What does this change?

SECURITY.md listed only 0.11.x as supported, although 0.12.0 to 0.12.5 have been released. This PR lists 0.12.x and 0.11.x as supported, says fixes are backported to the release branches of the supported versions, and adds a Release docs workflow (.github/scripts/check-release-docs.py) that fails while SECURITY.md falls behind the releases again. It is the same check as in DataSQRL/sqrl#2614, without the compatibility table part, since the runner has none.

The check reads the X.Y.Z tags of the remote and checks one release line: the latest one on main, and X.Y on a release-X.Y branch or an X.Y.Z tag. Older lines are only checked while SECURITY.md lists them as supported. SECURITY.md must list the release line as supported, and < oldest supported version as unsupported.

It runs on every PR and push to main and release-*, and on release tag pushes, instead of only when SECURITY.md changes, because a new tag makes it stale without any file changing. So after a new minor is tagged, PRs fail this check until SECURITY.md is updated. RELEASE.md now says to update it before tagging a new minor.

Follow-up: release-0.12 needs the same SECURITY.md change; the check fails on PRs to that branch until then.

Area

  • Build / CI / dependencies
  • Docs (README.md, stdlib-docs)

How did you test it?

Ran the script locally against this branch, worktrees of main, release-0.11 and release-0.12, and the 0.11.4 and 0.12.5 tags. The updated SECURITY.md passes; the current main, release-0.12 and 0.12.5 fail with must list 0.12.x as supported; release-0.11 and 0.11.4 pass; release-0.10 and pre-release tags are skipped; a malformed supported version and a missing < x.y row fail. The workflow runs on this PR.

Checklist

  • The PR title starts with a type such as feat:, fix: or docs:, optionally with a scope (e.g. fix(flexible-json):)
  • mvn clean install passes locally and the code is formatted with mvn spotless:apply (no Java changes)
  • New or changed behavior is covered by tests (given_when_then naming, AssertJ assertions) (CI script, tested manually as above)
  • New dependency and plugin versions are defined as properties in the root pom.xml (not applicable)
  • Commits are signed off and signed (git commit -s -S)
  • README.md and stdlib-docs are updated if user-facing behavior or functions changed (not applicable)

🤖 Generated with Claude Code

Signed-off-by: Ferenc Csaky <ferenc@datasqrl.com>
@ferenc-csaky
ferenc-csaky merged commit fd7a526 into main Nov 17, 2026
14 checks passed
@ferenc-csaky
ferenc-csaky deleted the ci/release-docs-check branch November 17, 2026 18:22
ferenc-csaky added a commit that referenced this pull request Nov 17, 2026
Signed-off-by: Ferenc Csaky <ferenc@datasqrl.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant